Skip to content

DOC: fix EX03 errors in docstrings - pandas.io.json.build_table_schema, pandas.read_stata, pandas.plotting.scatter_matrix, pandas.Index.droplevel , pandas.Grouper #56880

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Jan 15, 2024
Merged

DOC: fix EX03 errors in docstrings - pandas.io.json.build_table_schema, pandas.read_stata, pandas.plotting.scatter_matrix, pandas.Index.droplevel , pandas.Grouper #56880

merged 3 commits into from
Jan 15, 2024

Conversation

jordan-d-murphy
Copy link
Contributor

All EX03 Errors resolved in the following cases:

  1. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.io.json.build_table_schema
  2. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.read_stata
  3. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.plotting.scatter_matrix
  4. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.Index.droplevel
  5. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.Grouper

OUTPUT:

  1. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.io.json.build_table_schema
################################################################################
################################## Validation ##################################
################################################################################

4 Errors found for `pandas.io.json.build_table_schema`:
	No extended summary found
	Parameter "data" has no description
	Return value has no description
	See Also section not found
  1. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.read_stata
################################################################################
################################## Validation ##################################
################################################################################

2 Errors found for `pandas.read_stata`:
	No extended summary found
	Return value has no description
  1. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.plotting.scatter_matrix
################################################################################
################################## Validation ##################################
################################################################################

4 Errors found for `pandas.plotting.scatter_matrix`:
	No extended summary found
	Parameter "frame" has no description
	Parameter "ax" has no description
	See Also section not found
  1. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.Index.droplevel
################################################################################
################################## Validation ##################################
################################################################################

2 Errors found for `pandas.Index.droplevel`:
	Return value has no description
	See Also section not found
  1. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.Grouper
################################################################################
################################## Validation ##################################
################################################################################

3 Errors found for `pandas.Grouper`:
	Parameters {'*args', '**kwargs'} not documented
	Unknown parameters {'label', 'level', 'origin', 'sort', 'freq', 'closed', 'key', 'convention', 'offset', 'dropna', 'axis'}
	See Also section not found

@jordan-d-murphy
DOC: fix EX03 errors in docstrings - pandas.io.json.build_table_schem…
28c7f74 
…a, pandas.read_stata, pandas.plotting.scatter_matrix, pandas.Index.droplevel , pandas.Grouper
@mroeschke mroeschke added this to the 3.0 milestone Jan 15, 2024
@mroeschke mroeschke merged commit 178a352 into pandas-dev:main Jan 15, 2024
@mroeschke
Copy link
Member

Thanks @jordan-d-murphy

@jordan-d-murphy jordan-d-murphy deleted the issue#56804_8 branch January 15, 2024 23:17
pmhatre1 pushed a commit to pmhatre1/pandas-pmhatre1 that referenced this pull request May 7, 2024
@jordan-d-murphy @datapythonista @pmhatre1
DOC: fix EX03 errors in docstrings - pandas.io.json.build_table_schem…
727f6a4 
…a, pandas.read_stata, pandas.plotting.scatter_matrix, pandas.Index.droplevel , pandas.Grouper (pandas-dev#56880)

Co-authored-by: Marc Garcia <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@datapythonista datapythonista datapythonista approved these changes

@mroeschke mroeschke mroeschke approved these changes

@rhshadrach rhshadrach Awaiting requested review from rhshadrach rhshadrach is a code owner

Assignees
No one assigned
Labels
Docs
Projects
None yet
Milestone
3.0
Development

Successfully merging this pull request may close these issues.
3 participants
@jordan-d-murphy @mroeschke @datapythonista